Prevent extra attributes in component configs #2978

schustmi · 2024-09-02T11:50:30Z

Describe changes

Prevent extra attributes in the config classes of our stack components. Previously, this was defined in the StackComponentConfig parent class, but due to the inheritance order lots of our stack components allowed extra attributes. This PR fixes that by making sure extras are not allowed during stack component config validation.

I also thought about changing the inheritance order of all config classes. However I think it is very unreliable and might lead to newly created stack components having the same issues again. It would also lead to crashes for existing stack components that were registered with a "faulty" config, which my solution does not. It will only fail if users now try to update such a faulty component, at which point they will have to remove the extra attributes.
Potential issues with my implementation: If some stack component would require extra="allow" in their configuration for some reason, this would now be ignored and extras will not be allowed. I can't think of any case where this would be necessary though.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-09-02T11:50:36Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

bcdurak

Looks good!

If I understood correctly, people will still be able to use their Stack and StackComponent objects in Python with "faulty" configs for the time being. This is just blocking them from creating new "faulty" components or updating them in a bad way. We should maybe look into incorporating this into our design at some point in the future.

Added some small comments, feel free to ignore.

tests/unit/stack/test_utils.py

bcdurak · 2024-09-03T07:54:39Z

src/zenml/stack/utils.py

+    validation_config_class = type(
+        config_class.__name__,
+        (config_class,),
+        {"model_config": {"extra": "forbid"}},


At first, I thought that this line may overwrite the whole model_config but it actually updated it. Good one!

bcdurak · 2024-09-03T08:02:44Z

src/zenml/stack/utils.py

@@ -75,7 +75,16 @@ def validate_stack_component_config(
            return None
        raise

-    configuration = flavor_class.config_class(**configuration_dict)
+    config_class = flavor_class.config_class
+    # Make sure extras are forbidden for the config class. Due to inheritance


As you mentioned in the description, for whatever reason, if a user sets the extra to allow, perhaps we can use a warning or a debug message here.

The problem is, I can't even detect that right? Whether someone did it explicitly or whether it happened due to inheritance of BaseSettings

True. Feel free to skip it.

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

Prevent extra attributes in component configs

0f5802a

github-actions bot added internal To filter out internal PRs and issues bug Something isn't working labels Sep 2, 2024

schustmi requested a review from bcdurak September 2, 2024 12:25

Fix typo

57f4859

schustmi added the run-slow-ci label Sep 3, 2024

bcdurak approved these changes Sep 3, 2024

View reviewed changes

schustmi and others added 2 commits September 3, 2024 10:13

Update tests/unit/stack/test_utils.py

75c5c7f

Co-authored-by: Barış Can Durak <36421093+bcdurak@users.noreply.github.com>

Linting

00b74c8

schustmi merged commit 99f5cc1 into develop Sep 3, 2024
73 checks passed

schustmi deleted the bugfix/prevent-extra-attributes-in-component-config branch September 3, 2024 11:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent extra attributes in component configs #2978

Prevent extra attributes in component configs #2978

schustmi commented Sep 2, 2024 •

edited

Loading

coderabbitai bot commented Sep 2, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

bcdurak left a comment

bcdurak Sep 3, 2024

bcdurak Sep 3, 2024

schustmi Sep 3, 2024

bcdurak Sep 3, 2024

Prevent extra attributes in component configs #2978

Prevent extra attributes in component configs #2978

Conversation

schustmi commented Sep 2, 2024 • edited Loading

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Sep 2, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

bcdurak left a comment

Choose a reason for hiding this comment

bcdurak Sep 3, 2024

Choose a reason for hiding this comment

bcdurak Sep 3, 2024

Choose a reason for hiding this comment

schustmi Sep 3, 2024

Choose a reason for hiding this comment

bcdurak Sep 3, 2024

Choose a reason for hiding this comment

schustmi commented Sep 2, 2024 •

edited

Loading

coderabbitai bot commented Sep 2, 2024 •

edited

Loading